[Kotlin Spring] fix: Omit example field if not set#24228
Open
wegendt-bosch wants to merge 2 commits into
Open
Conversation
Contributor
Author
|
cubic is sorta right: it avoids |
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 2 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Contributor
Author
|
Hm, actually this disables all emits of |
4b6b056 to
67e597c
Compare
wegendt-bosch
commented
Jul 7, 2026
| */ | ||
| data class Pet( | ||
|
|
||
| @Schema(example = "doggie", required = true, description = "") |
Contributor
Author
There was a problem hiding this comment.
works now: example is emitted if set
Contributor
Author
|
@karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) please review :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #24227.
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
Summary by cubic
Stop emitting empty example attributes in Kotlin Spring–generated annotations. Only include
examplewhen the schema defines one; removesexample = "null"andexample = ""from outputs. Fixes #24227.AbstractKotlinCodegen#toExampleValueto returnnullunlessschema.exampleis set, omitting default/empty examples in annotations like@Schema/@ApiModelProperty.KotlinSpringServerCodegenTestexpectations and regenerated Kotlin Spring samples so annotations now include onlydescription/requiredwhen no example is provided.Written for commit e2da581. Summary will update on new commits.